gdk: Fill in some blanks in the docs
authorMatthias Clasen <mclasen@redhat.com>
Mon, 4 Dec 2017 23:58:30 +0000 (15:58 -0800)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 4 Dec 2017 23:58:30 +0000 (15:58 -0800)
This is just an initial cut; more work is needed.

gdk/gdkclipboard.c
gdk/gdkcontentdeserializer.c
gdk/gdkcontentformats.c
gdk/gdkcontentprovider.c
gdk/gdkcontentserializer.c
gdk/gdktexture.c
gdk/gdkvulkancontext.c

index 94e22474be824288c8fc19bd7105b0560d8841e6..1f5f5cf1d5539b6f6e761ebdb081e0338c1b2588 100644 (file)
 #include "gdkpipeiostreamprivate.h"
 #include "gdktexture.h"
 
+/**
+ * SECTION:gdkclipboard
+ * @Short_description: Share data between applications for Copy-and-Paste
+ * @Title: Clipboards
+ * @See_also: #GdkContentProvider, #GdkContentFormats
+ *
+ * The #GdkClipboard object represents a clipboard of data shared
+ * between different applications or between different parts of
+ * the same application.
+ *
+ * To get a GdkClipboard object, use gdk_display_get_clipboard() or
+ * gdk_display_get_primary_clipboard().
+ */
+
 typedef struct _GdkClipboardPrivate GdkClipboardPrivate;
 
 struct _GdkClipboardPrivate
@@ -453,7 +467,7 @@ gdk_clipboard_get_formats (GdkClipboard *clipboard)
  * gdk_clipboard_is_local:
  * @clipboard: a #GdkClipboard
  *
- * Returns if the clipboard is local. A clipboard is consideredlocal if it was
+ * Returns if the clipboard is local. A clipboard is considered local if it was
  * last claimed by the running application.
  *
  * Note that gdk_clipboard_get_content() may return %NULL even on a local
index 64390b90803a72963731ff5761433aa8b3122ec5..921f94dcadd12f8a1e1dd7b578c3007d0722c1f6 100644 (file)
 
 #include <gdk-pixbuf/gdk-pixbuf.h>
 
+
+/**
+ * SECTION:gdkcontentdeserializer
+ * @Short_description: Deserialize content for transfer
+ * @Title: GdkContentSerializer
+ * @See_also: #GdkContentDeserializer
+ *
+ * A GdkContentDeserializer is used to deserialize content for inter-application
+ * data transfers.
+ */
+
 typedef struct _Deserializer Deserializer;
 
 struct _Deserializer 
index ab97163dcc954a8922ffa0c1edf3d5d7af9954e4..04bd0647f48431cd6240245d28e281c182a26f31 100644 (file)
@@ -20,7 +20,7 @@
  * @Title: Content Formats
  * @Short_description: Advertising and negotiating of content
  *     exchange formats
- * @See_also: #GdkDragContext, #GdkClipboard
+ * @See_also: #GdkDragContext, #GdkClipboard, #GdkContentProvider
  *
  * This section describes the #GdkContentFormats structure that is used to
  * advertise and negotiate the format of content passed between different
index 9d89f9450b98b44f63d1da21ea5ad821eaa0a33f..235d1955222d470d94852fa23e609a64de1f2a61 100644 (file)
 #include "gdkcontentformats.h"
 #include "gdkintl.h"
 
+/**
+ * SECTION:gdkcontentprovider
+ * @Short_description: Provides content for data transfer between applications
+ * @Title: GdkContentProvider
+ *
+ * A GdkContentProvider is used to provide content for the clipboard in
+ * a number of formats.
+ */
+
 typedef struct _GdkContentProviderPrivate GdkContentProviderPrivate;
 
 struct _GdkContentProviderPrivate
index d4421cec9fc59efe3de8c1cca162c256ff99416b..e033272ac5f40aae762728b55fc56ad8541e467e 100644 (file)
 #include <gdk-pixbuf/gdk-pixbuf.h>
 #include <string.h>
 
+
+/**
+ * SECTION:gdkcontentserializer
+ * @Short_description: Serialize content for transfer
+ * @Title: GdkContentSerializer
+ * @See_also: #GdkContentDeserializer, #GdkContentProvider
+ *
+ * A GdkContentSerializer is used to serialize content for inter-application
+ * data transfers.
+ */
+
 typedef struct _Serializer Serializer;
 
 struct _Serializer 
index 69212976463187b7f86600907c4fd447d54974c2..09a06fa2485b1221436317899fc027d5d360f660 100644 (file)
@@ -17,7 +17,7 @@
  */
 
 /**
- * SECTION:GdkTexture
+ * SECTION:textures
  * @Title: GdkTexture
  * @Short_description: Pixel data
  *
index 3fd697a8af30f1a47e8fb570d305396614098793..6651f52472d2fa784205018898eb66b6385ca19a 100644 (file)
 #include "gdkinternals.h"
 #include "gdkintl.h"
 
+/**
+ * SECTION:gdkvulkancontext
+ * @Title: GdkVulkanContext
+ * @Short_description: Vulkan context
+ *
+ * #GdkVulkanContext is an object representing the platform-specific
+ * Vulkan drawing context.
+ *
+ * #GdkVulkanContexts are created for a #GdkWindow using
+ * gdk_window_create_vulkan_context(), and the context will match the
+ * the characteristics of the window.
+ *
+ * Support for #GdkGLContext is platform-specific, context creation
+ * can fail, returning %NULL context.
+ */
+
 typedef struct _GdkVulkanContextPrivate GdkVulkanContextPrivate;
 
 struct _GdkVulkanContextPrivate {